Update README.md plugins section #286
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds instructions for the plugin sub-command.
nightlark
reviewed
Nov 19, 2024
| @@ -46,6 +47,6 @@ def write_sbom(sbom: SBOM, outfile) -> None: | |||
| [project.entry-points."surfactant"] | |||
| sampleplugin = "sampleplugin" | |||
| ``` | |||
| From the same folder as your sampleplugin files, run `pip install .` to install your plugin and surfactant will automatically load and use the plugin. | |||
| Run `surfactant plugin install sampleplugin` to install the plugin. Surfactant will automatically load and use the plugin. Alternatively, from the same folder as your sampleplugin files, run `pip install .`. | |||
There was a problem hiding this comment.
Since surfactant plugin install is calling pip, this should probably just say to run surfactant plugin install . (or the path to the folder on their local filesystem that the plugin is located in) so that pip doesn't try to find a package on PyPI that either doesn't exist yet (or a completely different package someone else created that happens to have the same name).
We could mention uploading their plugin to PyPI for easier sharing and to enable installation using the PyPI package name for the plugin.
nightlark
reviewed
Nov 19, 2024
| @@ -26,7 +26,8 @@ In order to create a plugin, you will need to write your implementation for one | |||
|
|
|||
| ### Step 2. Write pyproject.toml File | |||
|
|
|||
| Once you have written your plugin, you will need to write a pyproject.toml file. Include any relevant project metadata/dependencies for your plugin, as well as an entry-point specification (example below) to make the plugin discoverable by surfactant. Once you write your .toml file, you can `pip install .` your plugin. | |||
| Once you have written your plugin, you will need to write a pyproject.toml file. Include any relevant project metadata/dependencies for your plugin, as well as an entry-point specification (example below) to make the plugin discoverable by surfactant. Once you write your .toml file, you can `surfactant plugin install <plugin name>` to install your plugin. Alternatively, you can `pip install .` your plugin. | |||
There was a problem hiding this comment.
We should say . or <path to plugin's folder> instead -- at this stage, they probably haven't uploaded their package to PyPI yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds instructions for the plugin sub-command.
Summary
If merged this pull request will
Proposed changes